.. _CScreenWorld Class:

==========================
CScreenWorld Class
==========================

.. toctree::
   :maxdepth: 1

* :ref:`Overview<CScreenWorld_Overview>`
* :ref:`Quick Reference<CScreenWorld_QuickRef>`
* :ref:`Constructors<CScreenWorld_Constructors>`
* :ref:`Methods<CScreenWorld_Methods>`

----

.. _CScreenWorld_Overview:

Overview
---------------

.. note:: The **CScreenWorld** class handles initial game world interactions and events before handing off to more specialized classes

The structure used for this class is :ref:`CScreenWorld<CScreenWorld>`

----

.. _CScreenWorld_QuickRef:

Quick Reference
---------------

+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Quick Ref**                                                                                                                                                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:CScreenWorld**\()                                                                                                                                                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:~CScreenWorld**\()                                                                                                                                                                                                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:ActivateDialogMenu**\()                                                                                                                                                                                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:AddGold**\(unsigned long dwGold)                                                                                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:AddTalker**\(long index)                                                                                                                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:AsynchronousUpdate**\(int bActiveEngine)                                                                                                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:CancelEngine**\()                                                                                                                                                                                                                        |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:Cheat_GiveAllSpells**\()                                                                                                                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:CheckAutomatedSpeedOptions**\()                                                                                                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:CheckEndOfHardPause**\()                                                                                                                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenWorld\:\:CheckMouseLButton**\()                                                                                                                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenWorld\:\:CheckMouseMButton**\()                                                                                                                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenWorld\:\:CheckMouseMove**\()                                                                                                                                                                                                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenWorld\:\:CheckMouseRButton**\()                                                                                                                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenWorld\:\:CheckMouseWheel**\()                                                                                                                                                                                                                      |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:CheckPartyValidity**\()                                                                                                                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenWorld\:\:CheckSystemKeyCapsLock**\()                                                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenWorld\:\:CheckSystemKeyCtrl**\()                                                                                                                                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenWorld\:\:CheckSystemKeyShift**\()                                                                                                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:ClearChatMessages**\()                                                                                                                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:ClearMenus**\()                                                                                                                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:ContainerScrollEnabled**\(int direction)                                                                                                                                                                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:CreateEngine**\(int nEngine)                                                                                                                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:DeleteArea**\(:ref:`CGameArea<CGameArea>`\* pArea)                                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:DeleteAreaMultiplayer**\()                                                                                                                                                                                                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:DisableEditKeys**\()                                                                                                                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:DisableKeyRepeat**\()                                                                                                                                                                                                                            |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:DisplayChatMessage**\(:ref:`CString<CString>` text)                                                                                                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| POSITION\* **CScreenWorld\:\:DisplayText**\(:ref:`CString<CString>`\& sSender, :ref:`CString<CString>`\& sText, long nMarker, int moveToTop)                                                                                                                            |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| POSITION\* **CScreenWorld\:\:DisplayText**\(:ref:`CString<CString>`\& sSender, :ref:`CString<CString>`\& sText, unsigned long nameColor, unsigned long textColor, long nMarker, int makeTop, unsigned long nDialogIndent, int appendToDialog)                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:EnableEditKeys**\(short typeFormat)                                                                                                                                                                                                      |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:EnableKeyRepeat**\()                                                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:EndDialog**\(unsigned char bForceExecution, unsigned char fullEnd)                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:EngineActivated**\()                                                                                                                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:EngineDeactivated**\()                                                                                                                                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:EngineDestroyed**\()                                                                                                                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:EngineInitialized**\()                                                                                                                                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:EngineGameInit**\()                                                                                                                                                                                                                      |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:EngineGameUninit**\()                                                                                                                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenWorld\:\:GetCapsLockKey**\()                                                                                                                                                                                                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenWorld\:\:GetCtrlKey**\()                                                                                                                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CString<CString>` **CScreenWorld\:\:GetCurrentTimeString**\()                                                                                                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CRect<CRect>` **CScreenWorld\:\:GetNewViewSize**\()                                                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual short **CScreenWorld\:\:GetNumVirtualKeys**\()                                                                                                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| long **CScreenWorld\:\:GetPickPartyCharacterId**\(int nPortrait)                                                                                                                                                                                                        |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| const char\* **CScreenWorld\:\:GetPickPartyPortrait**\(int nPortrait)                                                                                                                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenWorld\:\:GetSelectedCharacter**\()                                                                                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int **CScreenWorld\:\:GetShiftKey**\()                                                                                                                                                                                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:GetStateOverride**\()                                                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:GetTopGroundItem**\()                                                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual :ref:`CKeyInfo<CKeyInfo>`\* **CScreenWorld\:\:GetVirtualKeys**\()                                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual int\* **CScreenWorld\:\:GetVirtualKeysFlags**\()                                                                                                                                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:GroundScrollEnabled**\(int direction)                                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:GroupScrollEnabled**\(int direction)                                                                                                                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:HandleAmbiance**\()                                                                                                                                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:HandleDeathReaction**\()                                                                                                                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:HandleInteraction**\()                                                                                                                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:HideInterface**\()                                                                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:HighlightEnabled**\()                                                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:InteractionBlocked**\()                                                                                                                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:IsPauseInWait**\()                                                                                                                                                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:IsPickPartyDoneButtonClickable**\()                                                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:IsPickPartyRemoveButtonClickable**\()                                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| bool **CScreenWorld\:\:IsUIClear**\()                                                                                                                                                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:LeaveAreaLuaPanic**\(:ref:`CPoint<CPoint>` ptLocation, short nDirection, :ref:`CString<CString>` sAreaName, :ref:`CString<CString>` sParchment)                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:MoveToArea**\(:ref:`CString<CString>` areaName)                                                                                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnContainerButtonClick**\(unsigned long dwButtonId)                                                                                                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnContainerScroll**\(int direction)                                                                                                                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnDeathLoad**\()                                                                                                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnDeathQuit**\()                                                                                                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnDialogReplyClick**\(int index)                                                                                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual bool **CScreenWorld\:\:OnEvent**\(SDL_Event\* e)                                                                                                                                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnGroundButtonClick**\(int nSlot, long nContainer, const char\* res)                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnGroundScroll**\(int direction)                                                                                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnGroupScroll**\(int direction)                                                                                                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnHelpButtonClick**\()                                                                                                                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnKeyDown**\(int nKeysFlags)                                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnKeyUp**\(int nKeysFlags)                                                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnLButtonDblClk**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnLButtonDown**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnLButtonUp**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnMButtonDown**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnMButtonUp**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnMouseMove**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnMouseWheel**\(int bForward, long nTicks, unsigned long nLines, unsigned short wFlags)                                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnPickPartyDoneButtonClick**\()                                                                                                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnPickPartyPortraitButtonClick**\(int nPortrait)                                                                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnPortraitLClick**\(unsigned long id)                                                                                                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnQuickSaveButtonClick**\(int bExportSave)                                                                                                                                                                                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnRButtonDblClk**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnRButtonDown**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnRButtonUp**\(:ref:`CPoint<CPoint>` cPoint)                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:OnRestButtonClick**\()                                                                                                                                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:OnSelectionButtonClick**\()                                                                                                                                                                                                                      |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| unsigned char **CScreenWorld\:\:ReadyEndCredits**\(unsigned char bForcedFromServer)                                                                                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| unsigned char **CScreenWorld\:\:ReadyMovie**\(:ref:`CResRef<CResRef>`\& res, unsigned char bForcedFromServer, unsigned char bDelay)                                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:RemoveCharacterFromParty**\()                                                                                                                                                                                                                    |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:RemovePickPartyCharacterId**\(long nCharacterId)                                                                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:RenderFrameTimes**\()                                                                                                                                                                                                                            |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:ResetDialogStates**\(long ignore)                                                                                                                                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:ResetPickParty**\()                                                                                                                                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:ResetZoom**\()                                                                                                                                                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SaveScreen**\(:ref:`CGameArea<CGameArea>`\* pArea)                                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SetCurrentXP**\(unsigned long dwCurrentXP)                                                                                                                                                                                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SetDialogPortrait**\(:ref:`CResRef<CResRef>`\& resRef, int indexCurrentDialog)                                                                                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SetDialogTokens**\(:ref:`CGameSprite<CGameSprite>`\* pCharacter)                                                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SetHighlightEnabled**\(int enable)                                                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SetLeaveAreaLuaPanicData**\(:ref:`CPoint<CPoint>` ptValue, short nValue, :ref:`CString<CString>` sValue1, :ref:`CString<CString>` sValue2)                                                                                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SetPendingChapterChange**\(unsigned char nChapter, unsigned char\* szChapterResRef)                                                                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SetPendingMapWorld**\(int idController, short facingDirection)                                                                                                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SetPendingMovie**\(unsigned char\* szMovieResRef)                                                                                                                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SetPendingReformParty**\()                                                                                                                                                                                                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SetPendingRest**\(int nHP, unsigned char bRenting, unsigned char bMovie, int nGP)                                                                                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SetPendingTextScreenChange**\(unsigned char\* szTextScreenResRef)                                                                                                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:SetSystemKeyCapsLock**\(int bValue)                                                                                                                                                                                                      |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:SetSystemKeyCtrl**\(unsigned char bValue)                                                                                                                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:SetSystemKeyShift**\(int bValue)                                                                                                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartCommand**\()                                                                                                                                                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartContainer**\()                                                                                                                                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartDeath**\()                                                                                                                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartDeathReaction**\(:ref:`CString<CString>`\& sName)                                                                                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:StartDialog**\(:ref:`CGameSprite<CGameSprite>`\* pCharacter, :ref:`CGameSprite<CGameSprite>`\* pNPC, unsigned char checkHostility, unsigned char interaction, :ref:`CString<CString>`\& diaOverride, int bSuppressName, int bItemDialog)          |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartGroundItems**\()                                                                                                                                                                                                                            |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartMapWorldMultiplayerHost**\(int idController, short facingDirection)                                                                                                                                                                         |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartMovieMultiplayerHost**\(unsigned char\* cMovieResRef)                                                                                                                                                                                       |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartPickParty**\(int firstCall)                                                                                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartReformPartyMultiplayerHost**\()                                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartRestMultiplayerHost**\(int nHP, unsigned char bRenting, unsigned char bMovie, int nGP)                                                                                                                                                      |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartSaveGameMultiplayerHost**\()                                                                                                                                                                                                                |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartScroll**\(:ref:`CPoint<CPoint>` dest, short speed)                                                                                                                                                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StartStore**\(:ref:`CAIObjectType<CAIObjectType>`\& cAIProprietor, :ref:`CAIObjectType<CAIObjectType>`\& cAICustomer, :ref:`CResRef<CResRef>` cResStore, unsigned char bInitiate, unsigned char bCheckRestrict, unsigned char bCheckPermission)  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StepDialog**\()                                                                                                                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StopCommand**\()                                                                                                                                                                                                                                 |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StopContainer**\()                                                                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StopGroundItems**\()                                                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StopPickParty**\()                                                                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StopStore**\()                                                                                                                                                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:StoreGroup**\()                                                                                                                                                                                                                                  |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:SwapPortraits**\(int nID1, int nID2)                                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:TakeAllFromContainer**\()                                                                                                                                                                                                                        |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:TimerAsynchronousUpdate**\()                                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:TimerSynchronousUpdate**\()                                                                                                                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| int **CScreenWorld\:\:TogglePauseGame**\(unsigned char visualPause, unsigned char bSendMessage, int idPlayerPause, unsigned char bLogPause, unsigned char bRequireHostUnpause)                                                                                          |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:UnhideInterface**\()                                                                                                                                                                                                                             |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:UpdateContainerStatus**\(long nContainerId, short nSlotNum)                                                                                                                                                                              |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:UpdateLua**\()                                                                                                                                                                                                                                   |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:UpdatePartyGoldStatus**\()                                                                                                                                                                                                               |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| virtual void **CScreenWorld\:\:WindowResized**\(int w, int h)                                                                                                                                                                                                           |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void **CScreenWorld\:\:ZoomToMap**\(bool bOverwriteOriginal)                                                                                                                                                                                                            |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+


----

.. _CScreenWorld_Constructors:

Constructors
---------------

+----------------------------------------------------------------+------------------------------------------------------+
| **Name**                                                       | **Description**                                      |
+----------------------------------------------------------------+------------------------------------------------------+
| :ref:`CScreenWorld\:\:CScreenWorld<CScreenWorldCScreenWorld>`  | Constructs a ``CScreenWorld`` object                 |
+----------------------------------------------------------------+------------------------------------------------------+
| :ref:`CScreenWorld\:\:CScreenWorld<CScreenWorld~CScreenWorld>` | Destroys a ``CScreenWorld`` object                   |
+----------------------------------------------------------------+------------------------------------------------------+

.. _CScreenWorldCScreenWorld:

CScreenWorld\:\:CScreenWorld
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Constructs a ``CScreenWorld`` object

::

   void CScreenWorld::CScreenWorld();

**Remarks**

Constructs a ``CScreenWorld`` object


----

.. _CScreenWorld~CScreenWorld:

CScreenWorld\:\:~CScreenWorld
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Destroys the ``CScreenWorld`` object

::

   virtual void CScreenWorld::~CScreenWorld();

**Remarks**

Destroys the ``CScreenWorld`` object


----

.. _CScreenWorld_Methods:

Methods
---------------

+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **Name**                                                                                                               | **Description**                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:ActivateDialogMenu<CScreenWorldActivateDialogMenu>`                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:AddGold<CScreenWorldAddGold>`                                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:AddTalker<CScreenWorldAddTalker>`                                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:AsynchronousUpdate<CScreenWorldAsynchronousUpdate>`                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CancelEngine<CScreenWorldCancelEngine>`                                                          |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:Cheat_GiveAllSpells<CScreenWorldCheat_GiveAllSpells>`                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CheckAutomatedSpeedOptions<CScreenWorldCheckAutomatedSpeedOptions>`                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CheckEndOfHardPause<CScreenWorldCheckEndOfHardPause>`                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CheckMouseLButton<CScreenWorldCheckMouseLButton>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CheckMouseMButton<CScreenWorldCheckMouseMButton>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CheckMouseMove<CScreenWorldCheckMouseMove>`                                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CheckMouseRButton<CScreenWorldCheckMouseRButton>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CheckMouseWheel<CScreenWorldCheckMouseWheel>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CheckPartyValidity<CScreenWorldCheckPartyValidity>`                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CheckSystemKeyCapsLock<CScreenWorldCheckSystemKeyCapsLock>`                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CheckSystemKeyCtrl<CScreenWorldCheckSystemKeyCtrl>`                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CheckSystemKeyShift<CScreenWorldCheckSystemKeyShift>`                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:ClearChatMessages<CScreenWorldClearChatMessages>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:ClearMenus<CScreenWorldClearMenus>`                                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:ContainerScrollEnabled<CScreenWorldContainerScrollEnabled>`                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:CreateEngine<CScreenWorldCreateEngine>`                                                          |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:DeleteArea<CScreenWorldDeleteArea>`                                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:DeleteAreaMultiplayer<CScreenWorldDeleteAreaMultiplayer>`                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:DisableEditKeys<CScreenWorldDisableEditKeys>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:DisableKeyRepeat<CScreenWorldDisableKeyRepeat>`                                                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:DisplayChatMessage<CScreenWorldDisplayChatMessage>`                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:DisplayText<CScreenWorldDisplayText>`                                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:EnableEditKeys<CScreenWorldEnableEditKeys>`                                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:EnableKeyRepeat<CScreenWorldEnableKeyRepeat>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:EndDialog<CScreenWorldEndDialog>`                                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:EngineActivated<CScreenWorldEngineActivated>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:EngineDeactivated<CScreenWorldEngineDeactivated>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:EngineDestroyed<CScreenWorldEngineDestroyed>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:EngineInitialized<CScreenWorldEngineInitialized>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:EngineGameInit<CScreenWorldEngineGameInit>`                                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:EngineGameUninit<CScreenWorldEngineGameUninit>`                                                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetCapsLockKey<CScreenWorldGetCapsLockKey>`                                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetCtrlKey<CScreenWorldGetCtrlKey>`                                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetCurrentTimeString<CScreenWorldGetCurrentTimeString>`                                          |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetNewViewSize<CScreenWorldGetNewViewSize>`                                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetNumVirtualKeys<CScreenWorldGetNumVirtualKeys>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetPickPartyCharacterId<CScreenWorldGetPickPartyCharacterId>`                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetPickPartyPortrait<CScreenWorldGetPickPartyPortrait>`                                          |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetSelectedCharacter<CScreenWorldGetSelectedCharacter>`                                          |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetShiftKey<CScreenWorldGetShiftKey>`                                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetStateOverride<CScreenWorldGetStateOverride>`                                                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetTopGroundItem<CScreenWorldGetTopGroundItem>`                                                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetVirtualKeys<CScreenWorldGetVirtualKeys>`                                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GetVirtualKeysFlags<CScreenWorldGetVirtualKeysFlags>`                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GroundScrollEnabled<CScreenWorldGroundScrollEnabled>`                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:GroupScrollEnabled<CScreenWorldGroupScrollEnabled>`                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:HandleAmbiance<CScreenWorldHandleAmbiance>`                                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:HandleDeathReaction<CScreenWorldHandleDeathReaction>`                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:HandleInteraction<CScreenWorldHandleInteraction>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:HideInterface<CScreenWorldHideInterface>`                                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:HighlightEnabled<CScreenWorldHighlightEnabled>`                                                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:InteractionBlocked<CScreenWorldInteractionBlocked>`                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:IsPauseInWait<CScreenWorldIsPauseInWait>`                                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:IsPickPartyDoneButtonClickable<CScreenWorldIsPickPartyDoneButtonClickable>`                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:IsPickPartyRemoveButtonClickable<CScreenWorldIsPickPartyRemoveButtonClickable>`                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:IsUIClear<CScreenWorldIsUIClear>`                                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:LeaveAreaLuaPanic<CScreenWorldLeaveAreaLuaPanic>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:MoveToArea<CScreenWorldMoveToArea>`                                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnContainerButtonClick<CScreenWorldOnContainerButtonClick>`                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnContainerScroll<CScreenWorldOnContainerScroll>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnDeathLoad<CScreenWorldOnDeathLoad>`                                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnDeathQuit<CScreenWorldOnDeathQuit>`                                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnDialogReplyClick<CScreenWorldOnDialogReplyClick>`                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnEvent<CScreenWorldOnEvent>`                                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnGroundButtonClick<CScreenWorldOnGroundButtonClick>`                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnGroundScroll<CScreenWorldOnGroundScroll>`                                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnGroupScroll<CScreenWorldOnGroupScroll>`                                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnHelpButtonClick<CScreenWorldOnHelpButtonClick>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnKeyDown<CScreenWorldOnKeyDown>`                                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnKeyUp<CScreenWorldOnKeyUp>`                                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnLButtonDblClk<CScreenWorldOnLButtonDblClk>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnLButtonDown<CScreenWorldOnLButtonDown>`                                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnLButtonUp<CScreenWorldOnLButtonUp>`                                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnMButtonDown<CScreenWorldOnMButtonDown>`                                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnMButtonUp<CScreenWorldOnMButtonUp>`                                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnMouseMove<CScreenWorldOnMouseMove>`                                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnMouseWheel<CScreenWorldOnMouseWheel>`                                                          |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnPickPartyDoneButtonClick<CScreenWorldOnPickPartyDoneButtonClick>`                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnPickPartyPortraitButtonClick<CScreenWorldOnPickPartyPortraitButtonClick>`                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnPortraitLClick<CScreenWorldOnPortraitLClick>`                                                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnQuickSaveButtonClick<CScreenWorldOnQuickSaveButtonClick>`                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnRButtonDblClk<CScreenWorldOnRButtonDblClk>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnRButtonDown<CScreenWorldOnRButtonDown>`                                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnRButtonUp<CScreenWorldOnRButtonUp>`                                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnRestButtonClick<CScreenWorldOnRestButtonClick>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:OnSelectionButtonClick<CScreenWorldOnSelectionButtonClick>`                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:ReadyEndCredits<CScreenWorldReadyEndCredits>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:ReadyMovie<CScreenWorldReadyMovie>`                                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:RemoveCharacterFromParty<CScreenWorldRemoveCharacterFromParty>`                                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:RemovePickPartyCharacterId<CScreenWorldRemovePickPartyCharacterId>`                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:RenderFrameTimes<CScreenWorldRenderFrameTimes>`                                                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:ResetDialogStates<CScreenWorldResetDialogStates>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:ResetPickParty<CScreenWorldResetPickParty>`                                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:ResetZoom<CScreenWorldResetZoom>`                                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SaveScreen<CScreenWorldSaveScreen>`                                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetCurrentXP<CScreenWorldSetCurrentXP>`                                                          |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetDialogPortrait<CScreenWorldSetDialogPortrait>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetDialogTokens<CScreenWorldSetDialogTokens>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetHighlightEnabled<CScreenWorldSetHighlightEnabled>`                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetLeaveAreaLuaPanicData<CScreenWorldSetLeaveAreaLuaPanicData>`                                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetPendingChapterChange<CScreenWorldSetPendingChapterChange>`                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetPendingMapWorld<CScreenWorldSetPendingMapWorld>`                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetPendingMovie<CScreenWorldSetPendingMovie>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetPendingReformParty<CScreenWorldSetPendingReformParty>`                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetPendingRest<CScreenWorldSetPendingRest>`                                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetPendingTextScreenChange<CScreenWorldSetPendingTextScreenChange>`                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetSystemKeyCapsLock<CScreenWorldSetSystemKeyCapsLock>`                                          |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetSystemKeyCtrl<CScreenWorldSetSystemKeyCtrl>`                                                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SetSystemKeyShift<CScreenWorldSetSystemKeyShift>`                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartCommand<CScreenWorldStartCommand>`                                                          |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartContainer<CScreenWorldStartContainer>`                                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartDeath<CScreenWorldStartDeath>`                                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartDeathReaction<CScreenWorldStartDeathReaction>`                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartDialog<CScreenWorldStartDialog>`                                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartGroundItems<CScreenWorldStartGroundItems>`                                                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartMapWorldMultiplayerHost<CScreenWorldStartMapWorldMultiplayerHost>`                          |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartMovieMultiplayerHost<CScreenWorldStartMovieMultiplayerHost>`                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartPickParty<CScreenWorldStartPickParty>`                                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartReformPartyMultiplayerHost<CScreenWorldStartReformPartyMultiplayerHost>`                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartRestMultiplayerHost<CScreenWorldStartRestMultiplayerHost>`                                  |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartSaveGameMultiplayerHost<CScreenWorldStartSaveGameMultiplayerHost>`                          |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartScroll<CScreenWorldStartScroll>`                                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StartStore<CScreenWorldStartStore>`                                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StepDialog<CScreenWorldStepDialog>`                                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StopCommand<CScreenWorldStopCommand>`                                                            |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StopContainer<CScreenWorldStopContainer>`                                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StopGroundItems<CScreenWorldStopGroundItems>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StopPickParty<CScreenWorldStopPickParty>`                                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StopStore<CScreenWorldStopStore>`                                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:StoreGroup<CScreenWorldStoreGroup>`                                                              |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:SwapPortraits<CScreenWorldSwapPortraits>`                                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:TakeAllFromContainer<CScreenWorldTakeAllFromContainer>`                                          |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:TimerAsynchronousUpdate<CScreenWorldTimerAsynchronousUpdate>`                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:TimerSynchronousUpdate<CScreenWorldTimerSynchronousUpdate>`                                      |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:TogglePauseGame<CScreenWorldTogglePauseGame>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:UnhideInterface<CScreenWorldUnhideInterface>`                                                    |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:UpdateContainerStatus<CScreenWorldUpdateContainerStatus>`                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:UpdateLua<CScreenWorldUpdateLua>`                                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:UpdatePartyGoldStatus<CScreenWorldUpdatePartyGoldStatus>`                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:WindowResized<CScreenWorldWindowResized>`                                                        |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CScreenWorld\:\:ZoomToMap<CScreenWorldZoomToMap>`                                                                |                                                                                         |
+------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+


----

.. _CScreenWorldActivateDialogMenu:

CScreenWorld\:\:ActivateDialogMenu
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldAddGold:

CScreenWorld\:\:AddGold
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldAddTalker:

CScreenWorld\:\:AddTalker
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldAsynchronousUpdate:

CScreenWorld\:\:AsynchronousUpdate
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCancelEngine:

CScreenWorld\:\:CancelEngine
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCheat_GiveAllSpells:

CScreenWorld\:\:Cheat_GiveAllSpells
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCheckAutomatedSpeedOptions:

CScreenWorld\:\:CheckAutomatedSpeedOptions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCheckEndOfHardPause:

CScreenWorld\:\:CheckEndOfHardPause
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCheckMouseLButton:

CScreenWorld\:\:CheckMouseLButton
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCheckMouseMButton:

CScreenWorld\:\:CheckMouseMButton
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCheckMouseMove:

CScreenWorld\:\:CheckMouseMove
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCheckMouseRButton:

CScreenWorld\:\:CheckMouseRButton
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCheckMouseWheel:

CScreenWorld\:\:CheckMouseWheel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCheckPartyValidity:

CScreenWorld\:\:CheckPartyValidity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCheckSystemKeyCapsLock:

CScreenWorld\:\:CheckSystemKeyCapsLock
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCheckSystemKeyCtrl:

CScreenWorld\:\:CheckSystemKeyCtrl
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCheckSystemKeyShift:

CScreenWorld\:\:CheckSystemKeyShift
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldClearChatMessages:

CScreenWorld\:\:ClearChatMessages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldClearMenus:

CScreenWorld\:\:ClearMenus
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldContainerScrollEnabled:

CScreenWorld\:\:ContainerScrollEnabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldCreateEngine:

CScreenWorld\:\:CreateEngine
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldDeleteArea:

CScreenWorld\:\:DeleteArea
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldDeleteAreaMultiplayer:

CScreenWorld\:\:DeleteAreaMultiplayer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldDisableEditKeys:

CScreenWorld\:\:DisableEditKeys
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldDisableKeyRepeat:

CScreenWorld\:\:DisableKeyRepeat
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldDisplayChatMessage:

CScreenWorld\:\:DisplayChatMessage
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldDisplayText:

CScreenWorld\:\:DisplayText
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

CScreenWorld\:\:DisplayText
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldEnableEditKeys:

CScreenWorld\:\:EnableEditKeys
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldEnableKeyRepeat:

CScreenWorld\:\:EnableKeyRepeat
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldEndDialog:

CScreenWorld\:\:EndDialog
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldEngineActivated:

CScreenWorld\:\:EngineActivated
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldEngineDeactivated:

CScreenWorld\:\:EngineDeactivated
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldEngineDestroyed:

CScreenWorld\:\:EngineDestroyed
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldEngineInitialized:

CScreenWorld\:\:EngineInitialized
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldEngineGameInit:

CScreenWorld\:\:EngineGameInit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldEngineGameUninit:

CScreenWorld\:\:EngineGameUninit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetCapsLockKey:

CScreenWorld\:\:GetCapsLockKey
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetCtrlKey:

CScreenWorld\:\:GetCtrlKey
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetCurrentTimeString:

CScreenWorld\:\:GetCurrentTimeString
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetNewViewSize:

CScreenWorld\:\:GetNewViewSize
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetNumVirtualKeys:

CScreenWorld\:\:GetNumVirtualKeys
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetPickPartyCharacterId:

CScreenWorld\:\:GetPickPartyCharacterId
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetPickPartyPortrait:

CScreenWorld\:\:GetPickPartyPortrait
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetSelectedCharacter:

CScreenWorld\:\:GetSelectedCharacter
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetShiftKey:

CScreenWorld\:\:GetShiftKey
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetStateOverride:

CScreenWorld\:\:GetStateOverride
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetTopGroundItem:

CScreenWorld\:\:GetTopGroundItem
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetVirtualKeys:

CScreenWorld\:\:GetVirtualKeys
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGetVirtualKeysFlags:

CScreenWorld\:\:GetVirtualKeysFlags
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGroundScrollEnabled:

CScreenWorld\:\:GroundScrollEnabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldGroupScrollEnabled:

CScreenWorld\:\:GroupScrollEnabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldHandleAmbiance:

CScreenWorld\:\:HandleAmbiance
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldHandleDeathReaction:

CScreenWorld\:\:HandleDeathReaction
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldHandleInteraction:

CScreenWorld\:\:HandleInteraction
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldHideInterface:

CScreenWorld\:\:HideInterface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldHighlightEnabled:

CScreenWorld\:\:HighlightEnabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldInteractionBlocked:

CScreenWorld\:\:InteractionBlocked
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldIsPauseInWait:

CScreenWorld\:\:IsPauseInWait
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldIsPickPartyDoneButtonClickable:

CScreenWorld\:\:IsPickPartyDoneButtonClickable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldIsPickPartyRemoveButtonClickable:

CScreenWorld\:\:IsPickPartyRemoveButtonClickable
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldIsUIClear:

CScreenWorld\:\:IsUIClear
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldLeaveAreaLuaPanic:

CScreenWorld\:\:LeaveAreaLuaPanic
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldMoveToArea:

CScreenWorld\:\:MoveToArea
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnContainerButtonClick:

CScreenWorld\:\:OnContainerButtonClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnContainerScroll:

CScreenWorld\:\:OnContainerScroll
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnDeathLoad:

CScreenWorld\:\:OnDeathLoad
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnDeathQuit:

CScreenWorld\:\:OnDeathQuit
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnDialogReplyClick:

CScreenWorld\:\:OnDialogReplyClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnEvent:

CScreenWorld\:\:OnEvent
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnGroundButtonClick:

CScreenWorld\:\:OnGroundButtonClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnGroundScroll:

CScreenWorld\:\:OnGroundScroll
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnGroupScroll:

CScreenWorld\:\:OnGroupScroll
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnHelpButtonClick:

CScreenWorld\:\:OnHelpButtonClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnKeyDown:

CScreenWorld\:\:OnKeyDown
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnKeyUp:

CScreenWorld\:\:OnKeyUp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnLButtonDblClk:

CScreenWorld\:\:OnLButtonDblClk
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnLButtonDown:

CScreenWorld\:\:OnLButtonDown
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnLButtonUp:

CScreenWorld\:\:OnLButtonUp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnMButtonDown:

CScreenWorld\:\:OnMButtonDown
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnMButtonUp:

CScreenWorld\:\:OnMButtonUp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnMouseMove:

CScreenWorld\:\:OnMouseMove
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnMouseWheel:

CScreenWorld\:\:OnMouseWheel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnPickPartyDoneButtonClick:

CScreenWorld\:\:OnPickPartyDoneButtonClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnPickPartyPortraitButtonClick:

CScreenWorld\:\:OnPickPartyPortraitButtonClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnPortraitLClick:

CScreenWorld\:\:OnPortraitLClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnQuickSaveButtonClick:

CScreenWorld\:\:OnQuickSaveButtonClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnRButtonDblClk:

CScreenWorld\:\:OnRButtonDblClk
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnRButtonDown:

CScreenWorld\:\:OnRButtonDown
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnRButtonUp:

CScreenWorld\:\:OnRButtonUp
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnRestButtonClick:

CScreenWorld\:\:OnRestButtonClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldOnSelectionButtonClick:

CScreenWorld\:\:OnSelectionButtonClick
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldReadyEndCredits:

CScreenWorld\:\:ReadyEndCredits
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldReadyMovie:

CScreenWorld\:\:ReadyMovie
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldRemoveCharacterFromParty:

CScreenWorld\:\:RemoveCharacterFromParty
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldRemovePickPartyCharacterId:

CScreenWorld\:\:RemovePickPartyCharacterId
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldRenderFrameTimes:

CScreenWorld\:\:RenderFrameTimes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldResetDialogStates:

CScreenWorld\:\:ResetDialogStates
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldResetPickParty:

CScreenWorld\:\:ResetPickParty
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldResetZoom:

CScreenWorld\:\:ResetZoom
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSaveScreen:

CScreenWorld\:\:SaveScreen
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetCurrentXP:

CScreenWorld\:\:SetCurrentXP
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetDialogPortrait:

CScreenWorld\:\:SetDialogPortrait
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetDialogTokens:

CScreenWorld\:\:SetDialogTokens
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetHighlightEnabled:

CScreenWorld\:\:SetHighlightEnabled
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetLeaveAreaLuaPanicData:

CScreenWorld\:\:SetLeaveAreaLuaPanicData
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetPendingChapterChange:

CScreenWorld\:\:SetPendingChapterChange
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetPendingMapWorld:

CScreenWorld\:\:SetPendingMapWorld
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetPendingMovie:

CScreenWorld\:\:SetPendingMovie
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetPendingReformParty:

CScreenWorld\:\:SetPendingReformParty
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetPendingRest:

CScreenWorld\:\:SetPendingRest
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetPendingTextScreenChange:

CScreenWorld\:\:SetPendingTextScreenChange
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetSystemKeyCapsLock:

CScreenWorld\:\:SetSystemKeyCapsLock
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetSystemKeyCtrl:

CScreenWorld\:\:SetSystemKeyCtrl
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSetSystemKeyShift:

CScreenWorld\:\:SetSystemKeyShift
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartCommand:

CScreenWorld\:\:StartCommand
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartContainer:

CScreenWorld\:\:StartContainer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartDeath:

CScreenWorld\:\:StartDeath
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartDeathReaction:

CScreenWorld\:\:StartDeathReaction
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartDialog:

CScreenWorld\:\:StartDialog
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartGroundItems:

CScreenWorld\:\:StartGroundItems
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartMapWorldMultiplayerHost:

CScreenWorld\:\:StartMapWorldMultiplayerHost
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartMovieMultiplayerHost:

CScreenWorld\:\:StartMovieMultiplayerHost
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartPickParty:

CScreenWorld\:\:StartPickParty
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartReformPartyMultiplayerHost:

CScreenWorld\:\:StartReformPartyMultiplayerHost
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartRestMultiplayerHost:

CScreenWorld\:\:StartRestMultiplayerHost
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartSaveGameMultiplayerHost:

CScreenWorld\:\:StartSaveGameMultiplayerHost
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartScroll:

CScreenWorld\:\:StartScroll
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStartStore:

CScreenWorld\:\:StartStore
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStepDialog:

CScreenWorld\:\:StepDialog
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStopCommand:

CScreenWorld\:\:StopCommand
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStopContainer:

CScreenWorld\:\:StopContainer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStopGroundItems:

CScreenWorld\:\:StopGroundItems
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStopPickParty:

CScreenWorld\:\:StopPickParty
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStopStore:

CScreenWorld\:\:StopStore
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldStoreGroup:

CScreenWorld\:\:StoreGroup
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldSwapPortraits:

CScreenWorld\:\:SwapPortraits
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldTakeAllFromContainer:

CScreenWorld\:\:TakeAllFromContainer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldTimerAsynchronousUpdate:

CScreenWorld\:\:TimerAsynchronousUpdate
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldTimerSynchronousUpdate:

CScreenWorld\:\:TimerSynchronousUpdate
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldTogglePauseGame:

CScreenWorld\:\:TogglePauseGame
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldUnhideInterface:

CScreenWorld\:\:UnhideInterface
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldUpdateContainerStatus:

CScreenWorld\:\:UpdateContainerStatus
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldUpdateLua:

CScreenWorld\:\:UpdateLua
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldUpdatePartyGoldStatus:

CScreenWorld\:\:UpdatePartyGoldStatus
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldWindowResized:

CScreenWorld\:\:WindowResized
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CScreenWorldZoomToMap:

CScreenWorld\:\:ZoomToMap
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**